
        <HTML>
		<HEAD>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
		<meta name="description" content="Flash MX 2004 ActionScript2.0 Library: Ray - Wright Internet Solutions">
		<meta name="keywords" content="geometry,Ray,Flash,MX,2004,ActionScript,ActionScript2.0,AS2.0 Library,AS2,AS2 Library,Wright Internet Solutions,Wright,class,documentation,methods,functions,interfaces,JavaScript,Java">
		<TITLE>WIS AS2 Library : com.wis.math.geom.util.Ray Documentation</TITLE>

		<STYLE><!--
		HR.small{height:1px; width:100%; background:#E7BFA3; border: 0px;}
		HR.big{height:4px; width:100%; background:#E7BFA3; border: 0px;}
		A:hover{text-decoration: underline}
		A{text-decoration: none; color: #993333}
		code{font-family: monospace; font-size: 12px; color: #666666;}
		.methodAttributesTitle{font-size: 12px; font-weight: bold; color: #7B779C}
		.ToC{font-size: 12px; font-weight: bold; color: #993333}
		.methodTitle{font-size: 14px; font-weight: bold; color: #993333}
		.groupTitle{font-size: 18px; font-weight: bold; color: #993333}
		.sectionTitle{font-size: 22px; font-weight: bold; color: #993333}
		.majorTitle{font-size: 32px; font-weight: bold; color: #993333; padding-bottom:100px;}
		.methodsDiv{margin-left:40px;}
		.footer{font-size: 11px; color: #666666;}
		body{font-family: arial,sans-serif; font-size: 12px;}
		//--></STYLE>

		</HEAD>
		<BODY bgColor='#ffffcc'>
		<P class='majorTitle'>com.wis.math.geom.util.Ray Documentation</P>


		<P><B>Author:</B> <a href='mailto:wisolutions2002@shaw.ca?subject=wisASLibrary Ray Class'>Richard Wright</a><BR>
		<B>Last Modified:</B> 07/18/04 02:16:18<HR class='big'>

		<P class='sectionTitle'>Summary</P>
		<P class='ToC'>com.wis.math.geom.util.Ray class:</P>
		<div class='methodsDiv'><a href='#classinfo'>- description</a></div>
<P class='ToC'>com.wis.math.geom.util.Ray Properties:</P><div class='methodsDiv'>
<a href='#$start'>- $start</a><br>
<a href='#$dir'>- $dir</a><br>
<a href='#$distMult'>- $distMult</a><br>
<a href='#$isShadowTest'>- $isShadowTest</a><br>
<a href='#$trans'>- $trans</a><br>
<a href='#$ACCURACY'>- $ACCURACY</a><br>
</div><br>
<P class='ToC'>com.wis.math.geom.util.Ray Methods:</P><div class='methodsDiv'>
<a href='# copy'>-  copy</a><br>
<a href='# toString'>-  toString</a><br>
<a href='# transform'>-  transform</a><br>
<a href='# transformed'>-  transformed</a><br>
<a href='# tracer'>-  tracer</a><br>
<a href='# traceForColor'>-  traceForColor</a><br>
</div><br>

		<HR class='big'>
		<P class='sectionTitle'><A name='classinfo'></A>com.wis.math.geom.util.Ray <I>class</I></P>
		<P> <span class='methodTitle'>version:</span> 1.6</P>
		<P class="methodTitle">description:</P>
		<P>Implements the behaviours of the Ray Class.
 <p>
 		        Provides methods for the IObj interface based on JS RayTracer2 by
 John Haggerty.
 </P>
		<P class="methodTitle">usage:</P> <pre>var inst:Ray = new Ray(start,dir,distMult);</pre>

<P> <span class='methodTitle'>parameters:</span>
				<ul>
<li>      start (Vector)  -- a position Vector object.</li>
<li>      dir (Vector)  -- a direction Vector object.</li>
<li>      distMult (Number)  -- a scalar value for this instance's magnitude.</li>
</ul>

			<HR class='small'>
			<P class='groupTitle'><A name='properties'></A>com.wis.math.geom.util.Ray Properties:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name='$start'></A><u> $start</u></P>
				<P> (Vector)  -- start position of vector in 3-space.</P>

				<P class='methodTitle'><A name='$dir'></A><u> $dir</u></P>
				<P> (Vector)  -- direction of vector in 3-space.</P>

				<P class='methodTitle'><A name='$distMult'></A><u> $distMult</u></P>
				<P> (Number)  -- scaler for ray magnitude.</P>

				<P class='methodTitle'><A name='$isShadowTest'></A><u> $isShadowTest</u></P>
				<P> (Boolean)  -- default is 'false'. </P>

				<P class='methodTitle'><A name='$trans'></A><u> $trans</u></P>
				<P> (Transformation)  -- a Transformation object.</P>

				<P class='methodTitle'><A name='$ACCURACY'></A><u> $ACCURACY</u></P>
				<P> (Number)  -- static -- precision for calculations -- 1e-8.</P>
</div>

			<HR class='small'>
			<P class='groupTitle'><A name='methods'></A>com.wis.math.geom.util.Ray Methods:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name=' copy'></A><u>  copy</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Makes a copy of the class instance properties.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.copy();</pre>
     </P>
<P><span class='methodAttributesTitle'>returns:</span> (Ray)  -- returns a copy of the class instance.
    </P>

				<P class='methodTitle'><A name=' toString'></A><u>  toString</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Creates a descriptive string containing class Vector properties.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.toString();</pre>
     </P>
<P><span class='methodAttributesTitle'>returns:</span> (String)  -- returns a string containing class Vector properties.
    </P>

				<P class='methodTitle'><A name=' transform'></A><u>  transform</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Transforms this instance using passed 'trans' Transformation object.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.transform(trans);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  trans   (Transformation)  -- a Transformation object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Void)
    </P>

				<P class='methodTitle'><A name=' transformed'></A><u>  transformed</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Creates a new transformed Ray object.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.transformed(trans);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  trans   (Transformation)  -- a Transformation object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Ray)  -- returns a new transformed Ray object.
    </P>

				<P class='methodTitle'><A name=' tracer'></A><u>  tracer</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Trace this instance's path for intersection(s) with passed shape objects.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.tracer(obs,giveUpAt);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  objs_arr   (Array)  -- a list of shape objects.</li>
<li>  giveUpAt   (Number)  -- tests against newly created list of intersections' $depth property.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Intersection)  -- returns a new Intersection object.
    </P>

				<P class='methodTitle'><A name=' traceForColor'></A><u>  traceForColor</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Creates a new Col object by calling super's 'getColorAt' method.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.traceForColor(objs,lights,traceLevel,effect,clip)</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  objs_arr   (Array)  -- a list of shape objects.</li>
<li>  lights_arr   (Array)  -- a list of LightSource objects.</li>
<li>  traceLevel   (Number)  -- a maximum value for traces.</li>
<li>  effect   (Number)  -- -- a real number passed to test against super's $bailout property. </li>
<li>  clip   (MovieClip)  -- scope MovieClip object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Col)  -- returns a new Col object.
    </P>
</div>

			<BR>
			<BR>
			<HR class='big'>
			<span class="footer">generated with <A href='http://blog.klaustrofobik.org/' target='_blank'>AS2docGenerator beta 0.5.3</A></span>
			</BODY>
			</HTML>

